This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
feat: enable custom formats for dag put and get #3347
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…formats-for-dag-put-and-get
vasco-santos
suggested changes
Oct 26, 2020
| defaultHashAlg: multicodec.SHA2_256, | ||
| util: { | ||
| serialize (data) { | ||
| return Buffer.from(JSON.stringify(data)) |
There was a problem hiding this comment.
Should we use uint8ArrayFromString here per ipld/interface-ipld-format#utilserializeipldnode. It also needs to be required
There was a problem hiding this comment.
It's not necessary because the daemon only runs under node and node Buffers are Uint8Arrays so the interface contract is fulfilled.
| return Buffer.from(JSON.stringify(data)) | ||
| }, | ||
| deserialize (buf) { | ||
| return JSON.parse(buf.toString('utf8')) |
| } | ||
|
|
||
| const ipldOptions = (options && options.ipld) || {} | ||
| const configuredFormats = (ipldOptions && ipldOptions.formats) || [] |
There was a problem hiding this comment.
Suggested change
| const configuredFormats = (ipldOptions && ipldOptions.formats) || [] | |
| const configuredFormats = ipldOptions.formats || [] |
We do not need the extra validation per fallback above
| * @param {Function} [options.ipld.loadFormat] - An async function that can load a format when passed a codec name | ||
| * @returns {Function} | ||
| */ | ||
| module.exports = (options) => { |
There was a problem hiding this comment.
Suggested change
| module.exports = (options) => { | |
| module.exports = (options = {}) => { |
We are checking if options exists several times below, can we just set the default value here instead?
achingbrain
commented
Oct 26, 2020
| const codec = multicodec[format.toUpperCase().replace(/-/g, '_')] | ||
| // the node is an uncommon format which the client should have | ||
| // serialized so deserialize it before continuing | ||
| const ipldFormat = await request.server.app.ipfs.ipld._getFormat(format) |
There was a problem hiding this comment.
I've opened ipld/js-ipld#292 to make this getFormat(..) instead of _getFormat(..)
Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>
vasco-santos
approved these changes
Oct 27, 2020
achingbrain
deleted the
feat/enable-custom-formats-for-dag-put-and-get
branch
|
@vasco-santos @achingbrain this is great! ty! 🙂 |
|
No problem - just fixing up a few last problems with the typescript defs and this should go out of the door. |
achingbrain
added a commit
that referenced
this pull request
Oct 29, 2020
We bundle ipld formats for ethereum, zcash, bitcoin and git though they speak beyond the files part of the Interplanetary File System. Since #3347 we can now configure extra IPLD formats in the http client, in-process and daemon nodes, we no longer have to bundle these formats for them to be supported, instead the user can choose to configure their node with the formats they require. This makes the behaviour of core the same in node as it is in the browser and also means we don't waste time installing deps our users may not use. If they do use them, they can configure the node as they see fit. BREAKING CHANGE: only dag-pb, dag-cbor and raw formats are supported out of the box, any others will need to be configured during node startup.
achingbrain
added a commit
that referenced
this pull request
Oct 30, 2020
We bundle ipld formats for ethereum, zcash, bitcoin and git though they speak beyond the files part of the Interplanetary File System. Since #3347 we can now configure extra IPLD formats in the http client, in-process and daemon nodes, we no longer have to bundle these formats for them to be supported, instead the user can choose to configure their node with the formats they require. This makes the behaviour of core the same in node as it is in the browser and also means we don't waste time installing deps our users may not use. If they do use them, they can configure the node as they see fit. BREAKING CHANGE: only dag-pb, dag-cbor and raw formats are supported out of the box, any others will need to be configured during node startup.
SgtPooki
referenced
this pull request
in ipfs/js-kubo-rpc-client
Aug 18, 2022
Ensures we can use custom/extra IPLD formats with `ipfs.dag.get` and `ipfs.dag.put` over HTTP as well as directly into core. Adds an example to show how to do it. The basic idea is you configure your node with the extra formats and pass that node into the http server, so instead of having the IPLD format logic in the http method endpoint and in core it's just in core. The http client works the same as it did before. Co-authored-by: Vasco Santos <vasco.santos@moxy.studio> Co-authored-by: Janko Simonovic <simonovic86@gmail.com>
This was referenced Nov 30, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ensures we can use custom/extra IPLD formats with
ipfs.dag.getandipfs.dag.putover HTTP as well as directly into core.Adds an example to show how to do it.
The basic idea is you configure your node with the extra formats and pass that node into the http server, so instead of having the IPLD format logic in the http method endpoint and in core it's just in core. The http client works the same as it did before.